<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="HState,com.flashsim.FStEng.Three.HState,setDefaultStartState" name="keywords">
<title>com.flashsim.FStEng.Three.HState</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'HState - API Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Flash State Engine, version 3.0</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?com/flashsim/FStEng/Three/HState.html&amp;com/flashsim/FStEng/Three/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;HState</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class HState"); titleBar_setSubNav(true,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.flashsim.FStEng.Three</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class HState</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">HState <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="HStateC.html">HStateC</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="State.html">State</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
    A hierarchical state with a single sub-network.
    Hierarchical states can either have a single sub-network (collection of sub-states)--HState, or multiple networks of sub-states (HStateC).
    The HState is really a specialization of an HStateC that only has one sub-network.  Therefore, all the real code is going on in
    HStateC.
    
    <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProperty" id="hideInheritedProperty">
<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
</div>
<div class="showInheritedProperty" id="showInheritedProperty">
<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
</div>
</div>
<table id="summaryTableProperty" class="summaryTable hideInheritedProperty" cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#handledEvYet">handledEvYet</a> : Boolean<div class="summaryTableDescription">
   Boolean flag used to determine if the State has handled the current event.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#id">id</a> : String<div class="summaryTableDescription">
   String identifier for the state.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#myStMgr">myStMgr</a> : <a href="../Three/StateManager.html">StateManager</a>
<div class="summaryTableDescription">
   Pointer to this State's State Manager instance.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#name">name</a> : String<div class="summaryTableDescription">
   An optional name for the State to give to the State Manager, used for display purposes only.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="HStateC.html#numStMgrs">numStMgrs</a> : uint<div class="summaryTableDescription">
   Number of state managers (i.e., sub-networks) within this state.</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#pulseActivities">pulseActivities</a> : Array<div class="summaryTableDescription">
   An array containing the pulse activities (<code>PulseActivity</code>) for this state.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#_se">_se</a> : <a href="../Three/StateEngine.html">StateEngine</a>
<div class="summaryTableDescription">
   Pointer to the State Engine instance.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="HStateC.html#stMgrs">stMgrs</a> : Object<div class="summaryTableDescription">
   An object that holds a hash table (indexed by State Manager id's) to the State Managers for this state.</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="HStateC.html#substates">substates</a> : Object<div class="summaryTableDescription">
   Collection of children states.</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#transitions">transitions</a> : Object<div class="summaryTableDescription">
   An Object, keyed by target state id, that contains all the transitions for this State.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<div class="showHideLinks">
<div class="hideInheritedMethod" id="hideInheritedMethod">
<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
</div>
<div class="showInheritedMethod" id="showInheritedMethod">
<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
</div>
</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#HState()">HState</a>(identifier:*, msm:<a href="StateManager.html">StateManager</a> = null, nm:String = null)</div>
<div class="summaryTableDescription">
   Create a new hierarchical state with a single sub-network.</div>
</td><td class="summaryTableOwnerCol">HState</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#addPulseActivity()">addPulseActivity</a>(intvl:uint, cb:Function, fb:Boolean = false):<a href="../Three/PulseActivity.html">PulseActivity</a>
</div>
<div class="summaryTableDescription">
  Use this method to add an activity to the state that fires at a specified interval.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="HStateC.html#addStateManager()">addStateManager</a>(sm:<a href="../Three/StateManager.html">StateManager</a>):void</div>
<div class="summaryTableDescription">
   Adds the specified state manager (StateManager) to this state.</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="HStateC.html#addSubHState()">addSubHState</a>(sid:String, mgr:<a href="../Three/StateManager.html">StateManager</a> = null, name:String = null):<a href="../Three/HState.html">HState</a>
</div>
<div class="summaryTableDescription">
   Given an identifier, create a new sub-state that is a hierarchical state (HState).</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="HStateC.html#addSubHStateC()">addSubHStateC</a>(sid:String, mgr:<a href="../Three/StateManager.html">StateManager</a> = null, name:String = null):<a href="../Three/HStateC.html">HStateC</a>
</div>
<div class="summaryTableDescription">
   Given an identifier, create a new sub-state that is a concurrent, hierarchical state (HStateC).</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="HStateC.html#addSubState()">addSubState</a>(sid:String, mgr:<a href="../Three/StateManager.html">StateManager</a> = null, name:String = null):<a href="../Three/State.html">State</a>
</div>
<div class="summaryTableDescription">
   Given an identifier, create a new sub-state that is a simple state (State).</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#addTransitionExternal()">addTransitionExternal</a>(tEvtName:String, targetStateID:String, transFn:Function = null, ulfxt:uint = 1):<a href="../Three/Transition.html">Transition</a>
</div>
<div class="summaryTableDescription">
   Add an 'external' transition, i.e., from this State to a target state.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#addTransitionToHistory()">addTransitionToHistory</a>(tEvtName:String, targetStateID:String, transFn:Function = null):<a href="../Three/Transition.html">Transition</a>
</div>
<div class="summaryTableDescription">
   Add a transition from the current state to the history pseudo-state of a state.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#addTransitionToSelf()">addTransitionToSelf</a>(tEvtName:String, transFn:Function = null, ulfst:int = 0):<a href="../Three/Transition.html">Transition</a>
</div>
<div class="summaryTableDescription">
   Add a transition from this State to itself, specifying parents to exit and re-enter.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#addTransitionToTarget()">addTransitionToTarget</a>(tEvtName:String, targetStateID:String, transFn:Function = null):<a href="../Three/Transition.html">Transition</a>
</div>
<div class="summaryTableDescription">
   Add a transition from this State to a target state other than history.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#chgSt()">chgSt</a>(trans:<a href="../Three/Transition.html">Transition</a>, val:* = null):void</div>
<div class="summaryTableDescription">
  <p>Change state using transition trans_i, with an optional value for the
  transition function as a second argument.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#enter()">enter</a>(hist:Boolean = false, specIDs:Array = null):void</div>
<div class="summaryTableDescription">
  Called when the state is entered.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#isActive()">isActive</a>():Boolean</div>
<div class="summaryTableDescription">
  convenience function.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="HStateC.html#isSubstate()">isSubstate</a>(st:<a href="../Three/State.html">State</a>):Boolean</div>
<div class="summaryTableDescription">
   isSubstate allows the caller to ask if a state is a substate of the state being called.</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#leave()">leave</a>():void</div>
<div class="summaryTableDescription">
  Called when the state is exited (deactivated).</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#onEvent()">onEvent</a>(ev:Event, handledYet:Boolean):Boolean</div>
<div class="summaryTableDescription">
  <p>This is a new feature of FStEng v1.5, which provides an easy way to direct and process
  events.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#registerSubStates()">registerSubStates</a>(stateEng:<a href="../Three/StateEngine.html">StateEngine</a>):void</div>
<div class="summaryTableDescription">
  Goes through substates to register them with the state engine.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#removePulseActivity()">removePulseActivity</a>(pa:<a href="../Three/PulseActivity.html">PulseActivity</a>):void</div>
<div class="summaryTableDescription">
  Removes the specified pulse activity from the state.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="HStateC.html#removeState()">removeState</a>():void</div>
<div class="summaryTableDescription">
   Deletes memory associated with this state.</div>
</td><td class="summaryTableOwnerCol"><a href="HStateC.html">HStateC</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#removeTransition()">removeTransition</a>(trans:<a href="../Three/Transition.html">Transition</a>):void</div>
<div class="summaryTableDescription">
   Remove the given transition from this State.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="State.html#resetHistory()">resetHistory</a>():void</div>
<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setDefaultStartState()">setDefaultStartState</a>(sid:String, mgr:<a href="StateManager.html">StateManager</a> = null):void</div>
<div class="summaryTableDescription">
   Allows the developer to specify the default start state.</div>
</td><td class="summaryTableOwnerCol">HState</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<div class="showHideLinks">
<div class="hideInheritedConstant" id="hideInheritedConstant">
<a onclick="javascript:setInheritedVisible(false,'Constant');" href="#constantSummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Constants</a>
</div>
<div class="showInheritedConstant" id="showInheritedConstant">
<a onclick="javascript:setInheritedVisible(true,'Constant');" href="#constantSummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Constants</a>
</div>
</div>
<table id="summaryTableConstant" class="summaryTable hideInheritedConstant" cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#ENTRY">ENTRY</a> : String = "ENTRY"<div class="summaryTableDescription">[static]
   Event generated on entry to a state.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="State.html#LEAVE">LEAVE</a> : String = "LEAVE"<div class="summaryTableDescription">[static]
   Event generated when the state is no longer active.</div>
</td><td class="summaryTableOwnerCol"><a href="State.html">State</a></td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="HState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">HState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function HState(identifier:*, msm:<a href="StateManager.html">StateManager</a> = null, nm:String = null)</code><p>
   Create a new hierarchical state with a single sub-network.
   </p><p>You must assign the HState a unique identifier with respect to its sibling states, i.e., the states in the same network as this HState.
   Identifiers for states are, by convention, numeric, though the implementation uses Strings for identifiers (since numeric comparison is
   never required).</p>
   <p>When you create an HState, you must also create a state manager (StateManager).  When you create a StateManager, you
   specify the hierarchical state which it manages.</p>
   
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">identifier</span>:*</code> &mdash;  State identifier (id).  Must be unique among all states in the state engine.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">msm</span>:<a href="StateManager.html">StateManager</a></code> (default = <code>null</code>)<code></code> &mdash;   Pointer to the StateManager in the network that this HStateC belongs.  Pass in the parent
   state, not the StateManager that will control this state's sub-network.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">nm</span>:String</code> (default = <code>null</code>)<code></code> &mdash;    Display name of the State.  If null (not supplied), routines use the id for the display name.
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="setDefaultStartState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setDefaultStartState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public override function setDefaultStartState(sid:String, mgr:<a href="StateManager.html">StateManager</a> = null):void</code><p>
   Allows the developer to specify the default start state.
   </p><p>The default start state is specified in the State Manager, but for HState's, there is
   only one manager, so we can go ahead (if the manager is set) to adjust the default start
   state.</p>
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">sid</span>:String</code> &mdash; String identifier for the state
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">mgr</span>:<a href="StateManager.html">StateManager</a></code> (default = <code>null</code>)<code></code> &mdash; Optional parameter specifying the manager for the HState's sub-network (who is the manager for the state you're making default start).  This is declared for consistency with HStateC, though it always will be null for HState's (since we can determine it automatically)
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
